Importing Users

There are 2 techniques for accelerated addition of users into the system.

  • The first is "provisioning" - which will auto sync the Pyramid user list with groups in Active Directory. As such, this is only available with AD authentication.
  • The second involves uploading a list of users and their details with a static CSV formatted file - described below.
    • The "DB" template is for uploading users in a database authentication based system
    • The "AD" template is for uploading users in an Active Directory authentication based system

Note: Roles can also be uploaded into the system

DB Upload File format

The database file needs to be in comma delimited format, with the following columns:

  • username: the user id for login ID's should contain only standard alpha numeric characters and no spaces.
  • License Type: use 100 for Viewer or 200 for Professional.
  • Admin Level: 0 for no admin, 1 for domain admin, 2 for enterprise admin.
  • Tenant: use the tenant name as it appears in the system.
  • Roles: use the role name as it appears in the system. Multiple roles can be added using a semi-colon separator.
  • First Name: first name of user.
  • Last Name: last name of user.
  • Email: email address of user.
  • Password: initial password for the user.
  • UPN: Active Directory user name (optional, relevant when needing to connect to AD based data sources).
  • Profile: the user's profile (optional). Write one profile (by profile name) per user. The Profile must be compatible with the tenant.

The first row in the file is treated as a header row.

AD Upload File Format

The active directory file needs to be in comma delimited format, with the following columns:

  • domain\Username: AD account name in the format "domain\username". Ensure the domain is added to the system in the authentication settings.
  • License Type:write 100 for Viewer or 200 for Professional.
  • Admin Level: write 0 for no admin, 1 for domain admin, 2 for enterprise admin.
  • Tenant: use the tenant name as it appears in the system.
  • Roles: use the role name as it appears in the system. Multiple roles can be added using a semi-colon separator.
  • Profile: the user's profile (optional). Write one profile (by profile name) per user. The Profile must be compatible with the tenant.

The first row in the file is treated as a header row.